home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / qufe122.zip / QUFE.DOC < prev    next >
Text File  |  1989-11-03  |  8KB  |  182 lines
  1.  
  2.                   +-----------------------------------------+
  3.                   |                                         |
  4.                   |     QuickBBS UserFile Editor (QUFE)     |
  5.                   |                                         |
  6.                   |              Version 1.22               |
  7.                   |                                         |
  8.                   |   Copyright (c) 1989 by Mike Smedley    |
  9.                   |                                         |
  10.                   |           All Rights Reserved           |
  11.                   |                                         |
  12.                   +-----------------------------------------+
  13.  
  14.  
  15.     LICENSE
  16.  
  17.         QUFE is Freeware.  This means that there is no payment required, but
  18.         the program is still copyrighted and should be treated as such.
  19.         QUFE can be distributed freely as long as it is not modified in any
  20.         way.  You are not allowed to charge for QUFE with the exception of a
  21.         disk reproduction fee not to exceed $10.
  22.  
  23.  
  24.     DISCLAIMER
  25.  
  26.         The author, Mike Smedley, claims no responsibility for any damages
  27.         caused by the use or misuse of this program.  This program is
  28.         distributed "as is" with no warranty expressed or implied.  The
  29.         author will not be responsible for any losses incurred, either
  30.         directly or indirectly, by the use of this program.  Use this
  31.         program entirely at your own risk.
  32.  
  33.  
  34.     TRADEMARKS
  35.  
  36.         DESQview is a trademark of Quarterdeck Office Systems.
  37.         QuickBBS is a trademark of Adam Hudson.
  38.  
  39.  
  40.     REVISION HISTORY
  41.  
  42.         1.22  - Fixed bug in mouse detection.
  43.         1.21  - Minor cosmetic changes.
  44.         1.2   - Improved the configuration's color selection method.
  45.         1.11  - Fixed bug where a [S]earch after [E]dit would cause a
  46.                 lockup.
  47.         1.1   - Created an [A]dd Record command for adding new users.
  48.                 Now allows "None" for phone number fields.
  49.         1.01  - Fixed the Pack command so that it updates LASTREAD.BBS.
  50.         1.0   - Initial release.
  51.  
  52.  
  53.     CONTENTS
  54.  
  55.         The following files should be included in this archive:
  56.  
  57.             QUFE.DOC  - this documentation file
  58.             QUFE.EXE  - the executable program
  59.             QUFE.HLP  - the help file
  60.  
  61.  
  62.     QUICKBBS VERSIONS SUPPORTED
  63.  
  64.         This version of QUFE works with user files created by QuickBBS 2.03
  65.         and 2.04.  It may or may not work with other releases of QuickBBS.
  66.         You should be careful when using QUFE with newer releases of
  67.         QuickBBS - if the format of USERS.BBS, CONFIG.BBS, or LASTREAD.BBS
  68.         has changed, QUFE may not work properly.  To obtain the most recent
  69.         version of QUFE, you can FREQ it from 1:387/508 using the magic
  70.         request name of "QUFE".
  71.  
  72.  
  73.     DESCRIPTION
  74.  
  75.         QUFE is a program that allows you to view and manipulate the
  76.         QuickBBS user file (USERS.BBS) in many different ways, a single
  77.         record at a time, or a group of records at a time.  QUFE completely
  78.         replaces the need for QuickBBS' USEREDIT and USERPACK programs and
  79.         gives you much more power at the same time.
  80.  
  81.  
  82.     FEATURES
  83.  
  84.         o   Allows you to update a group of records matching a specified
  85.             selection criteria using a virtually unlimited number of
  86.             condition combinations.  This is probably the most powerful
  87.             feature of QUFE.  Some possible commands are:
  88.  
  89.             -   Select records where SecLevel <= 10 and NumUploads > 20.
  90.                 Update SecLevel to 20.
  91.  
  92.             -   Select all records.  Update FlagA1 to 0 and FlagB7 to 1.
  93.  
  94.             -   Select records where DateLastOn <= "12-31-88".  Update
  95.                 SecLevel to 0 and Credit to 0 and Deleted to "Y".
  96.  
  97.         o   You can also print user-defined reports based upon the same sort
  98.             of selection criteria.  The reports can be printed on the
  99.             printer, or sent to any other legal device or file.
  100.  
  101.         o   QUFE also has a Filter command which allows you to specify the
  102.             selection criteria that will be used when moving from record to
  103.             record.  This enables you to work with a more specific group of
  104.             users.  For example, if your selection criteria is:
  105.  
  106.                 Select records where SecLevel >= 100.
  107.  
  108.             then you will only be able to view sysop records.  If you are
  109.             currently at one sysop record, and press Next, you will advance
  110.             to the next sysop record, not the actual next record.  The
  111.             Filter affects all record movement commands including Previous,
  112.             Next, First, Last, Goto, and Search.
  113.  
  114.         o   Allows you to edit all fields of a QuickBBS user record, whereas
  115.             USEREDIT only lets you edit specific fields.
  116.  
  117.         o   The user password is masked with asterisks during display, and
  118.             shows only during edit.  This keeps people that may be watching
  119.             the screen from seeing a user's password.
  120.  
  121.         o   QUFE's Search does a case-insensitive search of the Name field
  122.             which makes it more flexible than USEREDIT.  For example, in
  123.             USEREDIT, the string "mith" would not match a user whose name is
  124.             "Smith".  It can also restrict searched records to those
  125.             matching a defined filter.
  126.  
  127.         o   QUFE has a built-in Pack command eliminating the need for
  128.             QuickBBS' USERPACK utility.
  129.  
  130.         o   QUFE has very extensive context-sensitive help from within the
  131.             environment.  This is the reason that the scope of this
  132.             documentation is so narrow.
  133.  
  134.         o   Can use either direct screen writes for speed, or BIOS screen
  135.             writes for compatibility with doorway and multitasking programs.
  136.  
  137.         o   QUFE has integrated mouse support.
  138.  
  139.         o   QUFE has "Shell to DOS" and "Execute DOS Command" commands from
  140.             within the environment.
  141.  
  142.  
  143.     INVOCATION SYNTAX
  144.  
  145.         To run QUFE, all you need to do is type "QUFE" from the DOS command
  146.         prompt.  The USERS.BBS and LASTREAD.BBS files must be in the current
  147.         directory.  There are a few command line switches available for use.
  148.         These switches are used to override a default or configured setting.
  149.         The allowable command line switches are:
  150.  
  151.             -b  Use BIOS for video writes.
  152.             -c  Use the default color setup.
  153.             -m  Use the default monochrome setup.
  154.             -s  Use snow suppresion (CGA only).
  155.  
  156.  
  157.     CONFIGURATION
  158.  
  159.         Configuration of QUFE is accomplished from within the program.  You
  160.         will need to select the menu item [O]ther, then [C]onfig.  Use the
  161.         [W]rite option to save the configuration file (QUFE.CFG) to disk,
  162.         and [S]ave to make the configuration take effect immediately.  When
  163.         you run QUFE from the command line, it will look for the
  164.         configuration file (QUFE.CFG) and use its parameters if it exists.
  165.         If the configuration file does not exist, then QUFE will use
  166.         defaults for the configuration options. Remember that you can also
  167.         override configured settings using the above command line switches.
  168.  
  169.  
  170.     ATTENTION C PROGRAMMERS
  171.  
  172.         QUFE was written in C using the powerful Shareware CXL C function
  173.         library by Mike Smedley.  All of the windows, menus, forms,
  174.         scrollable pick lists, context-sensitive help, keyboard and mouse
  175.         support were created and are managed by CXL.  Even with all these
  176.         functions of CXL linked in, QUFE is still a small memory model
  177.         program.  CXL is available for the Turbo C, Microsoft C, QuickC, and
  178.         Zortech C/C++ compilers. You can probably find it locally under the
  179.         file name "CXL??-?.*" but if not, then you can FREQ it from
  180.         1:387/508 using the magic request name of "CXL".
  181.  
  182.